home *** CD-ROM | disk | FTP | other *** search
Amiga HyperGuide | 1997-04-05 | 5.4 KB | 134 lines |
- @hyperguide directory.hguide
- @$VER: directory.hguide 40.3 (22.08.96)
- @macro m_prg "@{b}Directory DataType@{ub}"
- @include htds.hgm
-
- @node main "Directory DataType Documentation"
- @toc HTDS.hguide/main
- @prev html.hguide/main
- @next productinfo.hguide/main
-
- @{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}
-
- @{settabs 30}
- @{m_sec Menu}
- @{m_menuitem}@{" Configuration " link Configuration }@{m_menuinfo "Adapt to your needs"}
- @{m_menuitem}@{" Formats " link Formats }@{m_menuinfo "Formatting a entry"}
- @{m_menuitem}@{" Attributes " link hypertext.hguide/CommonAttrs }@{m_menuinfo "Using HyperGuide attributes"}
- @{m_menuitem}@{" Usage " link Usage }@{m_menuinfo "How to use the dirdt with MultiView"}
- @{m_menuitem}@{" Base Datatype " link hypertext.hguide/main }@{m_menuinfo "The HyperText Datatype"}
- @{line}
- @{m_menuitem}@{" Copyright " link HTDS.hguide/Copyright }@{m_menuinfo "legal stuff"}
- @{m_menuitem}@{" Author " link SR.hguide/Addresses }@{m_menuinfo "how to contact me"}
- @{m_menuitem}@{" Registration " link HTDS.hguide/Registration }@{m_menuinfo "It's Shareware !!!"}
- @{m_endsec}
-
- @endnode
- @node Configuration "Directory DataType/Configuration"
-
- @{m_sec "Configuration"}
- As the recommended standard for datatypes, the preference file for the
- directory.datatype is called @{m_file directory.prefs} and is searched first in
- the @{m_file PROGDIR:Prefs/DataTypes} and then in @{m_file Env:DataTypes} directory.
- The following options are currently available using ReadArgs() argument parsing :
-
-
- @{definition}
- FORMAT/K,SHOWTYPE/K,SORTBY/K,HIDEINFO/S,HIDEDOT/S,PARENTENTRY/S,USEDTLIB/S,ROOTENTRY/S :
-
- @{defterm}FORMAT
- @{defdata}This string specifies the directory entry format template.
- See @{" Entry Formats " link Formats} and @{" Common Attributes " link hypertext.hguide/CommonAttrs}
- for detailed information.
-
- @{defterm}SHOWTYPE
- @{defdata}Sets the type, how the dirctory should be shown.
- The following modes are available :
- @{definition}
- @{m_defitem "DIRSFIRST"}directories are listed before any files
- @{m_defitem "DIRSLAST" }directories are listed after any files
- @{m_defitem "MIXED" }directories and files are mixed.
- @{m_defitem "ICONS" }the directory is shown by icons of each directory/file.
- (Not implemented yet)
- @{enddefinition}
-
- @{defterm}SORTBY
- @{defdata}Sets the sorting criteria. Following modes are available :
- @{definition}
- @{m_defitem "NAME" }sorts directory by name
- @{m_defitem "LENGTH"}sorts directory by the length of the files
- @{m_defitem "DATE" }sorts directory by the date of the files
- @{enddefinition}
-
- @{defterm}HIDEINFO
- @{defdata}Indicates, that icon @{m_file .info} files should not be included
- in the directory list.
-
- @{defterm}HIDEDOT
- @{defdata}Indiactes, that file beginning with a dot should not be included
- in the directory list.@{line}
- For example the workbench @{m_file .backdrop} files are excluded.
-
- @{defterm}PARENTENTRY
- @{defdata}Indicates, that for each directory a parent directory entry
- should be included at the head of the listing.
-
- @{defterm}USEDTLIB
- @{defdata}Indicates, that the datatypes.library should be used to determine
- the type of the file, which will be shown with the @{m_sample %z} format command.
- If this isn't specifies only normal file types are shown like @{m_sample file},
- @{m_sample dir} etc.
-
- @{defterm}ROOTENTRY
- @{defdata}Indicates, that for each directory a root `directory' entry
- should be included at the head of the listing. This root `directory'
- is a list of all currently available volumes and assigns. You need for
- this my new Root: handler. See @{http_addr "http://home.pages.de/~Ruppert/amiga/"}.
- @{enddefinition}
- @{m_endsec}
- @endnode
- @node Formats "Directory DataType/Entry Formats"
-
- @{m_sec "Entry Formats"}
- Each directory entry is layouted using a entry format template. This
- template can consists out of HyperGuide style attributes and the
- following '%' format options. You can set this template in the
- @{"preference" link Configuration} file for the directory.datatype. For some
- of the format option you can specify the width in characters. To do so just
- include a number between the '%' and the character. For example @{m_sample "%30s"}. This
- is indicated with a @{m_sample [w]} string.
-
- @{definition}
- @{m_defitem "%a" }protection bits
- @{m_defitem "%[w]c"}comment. Default width is 20.
- @{m_defitem "%[w]d"}date. Default width is 9.
- @{m_defitem "%e" }suffix
- @{m_defitem "%f" }full filepath (not yet implemented)
- @{m_defitem "%[w]g"}group id. Default width is 8.
- @{m_defitem "%[w]l"}file length. Default width is 8.
- @{m_defitem "%m" }basename
- @{m_defitem "%n" }filename (not yet implemented)
- @{m_defitem "%p" }path (not yet implemented)
- @{m_defitem "%[w]s"}filename and link to the file. Default width is 20.
- @{m_defitem "%[w]t"}time. Default width is 9.
- @{m_defitem "%[w]u"}owner id. Default width is 8.
- @{m_defitem "%[w]z"}type of the entry (DataTypes/FileType). Default width is 8.
- @{enddefinition}
- @{m_endsec}
- @endnode
- @node Usage "Directory DataType/Usage"
-
- @{m_sec "Usage"}
- MultiView opens normally a file requester, if you specify a directory. To avoid
- this and to open a directory with MultiView you can specify the WINDOW option.
- This causes MultiView to open the window directly and the directory is displayed
- using the directory.datatype.
-
- For example :@{line}
-
- @{code}MultiView "" WINDOW :@{body} opens a window with the current directory.
- @{m_endsec}
- @endnode
-
-
-